Little more code cleanup.
[castle.git] / How to build.txt
blob68bcc648014728661947e6489f1c0bf65a80178e
1 Everything should compile fine using NAnt 0.85 final. \r
2 You can find the latest version at http://nant.sourceforge.net/ \r
3 \r
4 Anyway, the following are some useful tips if things go wrong for some reason.\r
5 \r
6 Where to start the build?\r
7 =========================\r
8 \r
9 Use the default.build in the root directory. It compiles everything in the right order, copies dependencies and so on.\r
11 Simply type\r
13   > nant\r
14 This will create a Debug build of the project\r
16 Use the following to build the trunk before attempting to load any solutions in your IDE for the first time, otherwise you may have reference problems:\r
18   > nant rebuild, or\r
19   > nant quick rebuild\r
22 Database tests\r
23 ==============\r
25 If you have MS SQL Server installed (default instance) just create two databases:\r
27 - test\r
28 - test2\r
30 If not, and you want to run the database tests, you must set the connection string, dialect and driver through NAnt defines. Otherwise you can disable the tests (see below).\r
32 The basic NHibernate settings can be set as NAnt arguments:\r
34 - ar.dialect sets the NHibernate dialect\r
36     > -D:ar.dialect=NHibernate.Dialect.MsSql2000Dialect\r
38 - ar.connection.driver_class sets the driver\r
40     > -D:ar.connection.driver_class=NHibernate.Driver.SqlClientDriver\r
42 - ar.connection.connection_string{1,2} set the connection strings for the test and test2 databases\r
44     > -D:ar.connection.connection_string.1="Data Source=.;Initial Catalog=test;Integrated Security=SSPI;"\r
45     > -D:ar.connection.connection_string.2="Data Source=.;Initial Catalog=test2;Integrated Security=SSPI;"\r
46   \r
47 Build options\r
48 =============\r
50 Build option selectors\r
51 ------------------------\r
53 Selectors are pseudo-targets, used to configure some part of the build.\r
54 They need to be put before real build targets.\r
56 debug:          "nant debug build" will build the project in debug configuration"\r
57 release:        "nant release rebuild" will rebuild the entire project in release configuration\r
58 quick:          "nant quick build" will run the build without tests and generally will try to skip as much as possible to speed up the build.\r
61 Disabling all tests\r
62 -------------------\r
64   > nant -D:common.testrunner.enabled=false\r
66 Selecting a different test framework (EXPERIMENTAL)\r
67 -------------------\r
69 NUnit (default)\r
70   > nant -D:testrunner=NUnit\r
72 MbUnit:\r
73   > nant -D:testrunner=MbUnit\r
75 N.B.\r
76 MbUnit or NUnit needs to be on the path, alternatively you can specify the test runner console location by\r
77 setting the properties -D:mbunit-console=<path to MBUnit.Cons.exe> or \r
78 -D:nunit-console=<path to nunit-console.exe> respectively.\r
81 Compiling a version not strongly signed\r
82 ---------------------------------------\r
84   > nant -D:sign=false\r
87 Allowing partial trust\r
88 ----------------------\r
90   > nant -D:assembly.allow-partially-trusted-callers=true\r
93 Building the Castle MSI installer\r
94 ----------------------\r
96   > nant installer\r
97   \r
98 You need to have installed the tools following for running this task:\r
99 - Sandcastle\r
100   http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en\r
102 - Sandcastle Help File Builder\r
103   http://www.codeplex.com/SHFB\r
105 - HTML Help 1.x compiler\r
106   http://www.microsoft.com/downloads/details.aspx?familyid=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en\r
108 - WiX v3.\r
109   http://wix.sourceforge.net/downloadv3.html\r
112 More questions? \r
113 ===============\r
115 Please direct more questions to our devel mailing list or our forum at http://www.castleproject.org/\r